home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.4 Applications 1997 August / SGI IRIX 6.4 Applications 1997 August.iso / dist / insight.idb / usr / share / catman / u_man / cat1 / sgihelp.z / sgihelp
Encoding:
Text File  |  1997-07-30  |  7.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))                                                          SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      sgihelp - The Silicon Graphics Help Viewer
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      /usr/sbin/sgihelp [ -debug ] [ -f ] [ -l lllliiiibbbbrrrraaaarrrryyyy____nnnnaaaammmmeeee ]
  13.                        [ -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee ] [ -b bbbbooooooookkkk____nnnnaaaammmmeeee ]
  14.                        [ -k hhhheeeellllpppp____kkkkeeeeyyyy ] [ -c ["VIEW"|"INDEX"] ]
  15.                        [ -m uuuusssseeeerrrr____ddddaaaattttaaaa ]
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _s_g_i_h_e_l_p is an online help viewer. This viewer provides an easy-to-use
  19.      interface which allows the user to browse through help information that
  20.      is distributed from _S_i_l_i_c_o_n _G_r_a_p_h_i_c_s.  ssssggggiiiihhhheeeellllpppp is based on the iiiinnnnssssiiiigggghhhhtttt(1)
  21.      on-line viewing technology.  The content for the help information that is
  22.      displayed is derived from the actual iiiinnnnssssiiiigggghhhhtttt(1) "books".
  23.  
  24.      ssssggggiiiihhhheeeellllpppp is an application that gets started only when a request is made
  25.      to get "help". A user should _n_e_v_e_r have to start sgihelp from the
  26.      command-line, unless it is used to generate a help request through a
  27.      combination of the command-line arguments described below.  Requests can
  28.      be generated from:
  29.  
  30.           o  Help menu item(s) found within an application
  31.           o  A help pushbutton on an application window
  32.           o  An application sending a request directly
  33.           o  SGIHelp itself
  34.  
  35.      ssssggggiiiihhhheeeellllpppp renders the request, if the help content is available (see
  36.      "FFFFIIIILLLLEEEESSSS" below). After the user closes all help windows, ssssggggiiiihhhheeeellllpppp sits in
  37.      the background process queue waiting for another request. If no activity
  38.      occurs for 10 minutes (default), it exits.  Note that the "10 minutes" is
  39.      a configurable number which a user could change in the application
  40.      defaults file (see "FFFFIIIILLLLEEEESSSS" below), or override in a local "_T_i_m_e_o_u_t_I_n_M_i_n".
  41.  
  42.      ssssggggiiiihhhheeeellllpppp is composed of two windows, the Viewer window and the Index
  43.      window. For further information, consult the ssssggggiiiihhhheeeellllpppp oooonnnn----lllliiiinnnneeee hhhheeeellllpppp.
  44.  
  45. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  46.      -app The -app aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee options tells _s_g_i_h_e_l_p to process a help
  47.           request for the given application. The aaaapppppppp____ccccllllaaaassssssssnnnnaaaammmmeeee coincides with
  48.           an associated help file that can be found in (default)
  49.           /_u_s_r/_s_h_a_r_e/_h_e_l_p or it can be the same as the name used for the
  50.           application's defaults file, found in /_u_s_r/_l_i_b/_X_1_1/_a_p_p-_d_e_f_a_u_l_t_s
  51.  
  52.      -b   The -b bbbbooooooookkkk____nnnnaaaammmmeeee option tells _s_g_i_h_e_l_p to examine the specified book
  53.           for help content for the given request.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the
  54.           abbreviated short title for the book.  Note that this option is
  55.           case-sensitive. For example,
  56.  
  57.           ssssggggiiiihhhheeeellllpppp ----bbbb IIIIRRRRIIIISSSSEEEEsssssssseeeennnnttttiiiiaaaallllssss ............
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))                                                          SSSSGGGGIIIIHHHHEEEELLLLPPPP((((1111))))
  71.  
  72.  
  73.  
  74.      -c   The -c """"VVVVIIIIEEEEWWWW"""" | """"IIIINNNNDDDDEEEEXXXX"""" option tells _s_g_i_h_e_l_p to invoke either the
  75.           Help Index window for this request("INDEX"), or a specific card
  76.           ("VIEW").  The default is "VIEW".
  77.  
  78.      -debug
  79.           Tells _s_g_i_h_e_l_p to print messages it is receiving to stdout.
  80.  
  81.      -f   The -f option tells _s_g_i_h_e_l_p to run in the foreground. The default is
  82.           to automatically background when starting.
  83.  
  84.      -k   The -k hhhheeeellllpppp____kkkkeeeeyyyy option tells _s_g_i_h_e_l_p to render the help card that
  85.           has a specified "HelpId=" attribute of hhhheeeellllpppp____kkkkeeeeyyyy.
  86.  
  87.      -l   The -l lllliiiibbbbrrrraaaarrrryyyy____nnnnaaaammmmeeee option tells _s_g_i_h_e_l_p to load the specified IRIS
  88.           InSight library.  A library is defined as a collection of
  89.           bookshelves. By default, the library is rooted at
  90.           /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_l_i_b_r_a_r_y. The path (relative or full) to the new
  91.           library should be specified.  Only one library may be specified. For
  92.           example,
  93.  
  94.           ssssggggiiiihhhheeeellllpppp ----llll ////uuuussssrrrr////sssshhhhaaaarrrreeee////IIIInnnnssssiiiigggghhhhtttt////lllliiiibbbb____XXXXXXXXXXXX ............
  95.  
  96.           Another method for specifying the designated library is to set the
  97.           resource, "_d_e_f_L_i_b_P_a_t_h". The resource value should be designated in
  98.           the same manner as lllliiiibbbbrrrraaaarrrryyyy____nnnnaaaammmmeeee, described previously.
  99.  
  100.      -m   The -m uuuusssseeeerrrr____ddddaaaattttaaaa option is used to pass data to _s_g_i_h_e_l_p and is
  101.           currently only used by the System Monitor; see ssssyyyyssssmmmmoooonnnn((((1111mmmm)))).
  102.  
  103. FFFFIIIILLLLEEEESSSS
  104.      /usr/sbin/sgihelp, /usr/lib/X11/app-defaults/SGIHelp
  105.  
  106.      Help content for the Indigo Magic Desktop is retrieved from the following
  107.      sample of book subsystems (subject to change):
  108.  
  109.      desktop_eoe.books.*     Indigo Magic Desktop Books
  110.      dmedia_eoe.books.*      Digital Media Tools User's Guide, Help
  111.      eoe.books.*             IRIX Execution Environment Books
  112.      imgtools.books.*        ImageVision Tools User's Guide, Help
  113.      impr_base.books.*       Impressario User's Guide
  114.      *.books.[Hh]elp         Various Help-related books
  115.      sysmon.books.*          Desktop System Monitor Help
  116.  
  117.  
  118. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  119.      _i_n_s_i_g_h_t(_1)
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.